/*
 * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package uk.org.ownage.dmdirc.ui.input;

import java.util.ArrayList;
import java.util.List;
import java.util.Locale;

import uk.org.ownage.dmdirc.Config;

/**
 * Represents the result set from a tab completion operation.
 * @author chris
 */
public final class TabCompleterResult {
    
    /**
     * The result list for this tab completer.
     */
    private final List<String> results;
    
    /**
     * Creates a new instance of TabCompleterResult with an empty result set.
     */
    public TabCompleterResult() {
	this.results = new ArrayList<String>();
    }
    
    /**
     * Creates a new instance of TabCompleterResult.
     * @param newResults The list of results that this result set contains
     */
    public TabCompleterResult(final List<String> newResults) {
	results = newResults;
    }
    
    /**
     * Adds a result to this result set.
     * @param result The result to be added
     */
    public void addResult(final String result) {
	results.add(result);
    }
    
    /**
     * Merges the specified additional results with this result set.
     * @param additional The results to merge
     */
    public void merge(final TabCompleterResult additional) {
	results.addAll(additional.getResults());
    }
    
    /**
     * Gets the total size of this result set.
     * @return the size of this result set
     */
    public int getResultCount() {
	return results.size();
    }
    
    /**
     * Returns the longest substring that matches all results.
     * @return longest possible substring matching all results
     */
    public String getBestSubstring() {
	if (getResultCount() == 0) {
	    return "";
	}
	
	final boolean caseSensitive = Boolean.parseBoolean(Config.getOption("tabcompletion", "casesensitive"));
	
	String res = results.get(0);
	for (String entry : results) {
	    if (caseSensitive) {
		while (!entry.startsWith(res)) {
		    res = res.substring(0, res.length() - 1);
		}
	    } else {
		while (!entry.toLowerCase(Locale.getDefault()).startsWith(
			res.toLowerCase(Locale.getDefault()))) {
		    res = res.substring(0, res.length() - 1);
		}
	    }
	}
	
	return res;
    }
    
    /**
     * Retrieves the list of results that this set contains.
     * @return An arraylist containing the results
     */
    public List<String> getResults() {
	return results;
    }
    
}
